DefendantClaimsApi v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Email: Iberinform Web: Iberinform
Authentication
-
API Key (ClientSecretHeader)
- Parameter Name: X-IBM-Client-Secret, in: header. Unique token directly related to the client contract
-
API Key (APIKeyHeader)
- Parameter Name: X-IBM-Client-Id, in: header.
Default
get__incidents_{organisationID}_defendant_claims
Code samples
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.get 'https://$(catalog.host)/modules/incidents/{organisationID}/defendant/claims',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.get('https://$(catalog.host)/modules/incidents/{organisationID}/defendant/claims', headers = headers)
print(r.json())
GET https://$(catalog.host)/modules/incidents/{organisationID}/defendant/claims HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/modules/incidents/{organisationID}/defendant/claims',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /incidents/{organisationID}/defendant/claims
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
organisationID | path | string | true | identificador de la firma |
language | query | string | false | Idioma generación |
Example responses
200 Response
"{"claims":[{"claimConcept":{"description":"string","id":"string"},"claimPublicationDate":"string","claimantType":{"description":"string","id":"string"},"claimedAmount":"string","endDate":"string","id":0,"idFile":"string","startDate":"string"}],"claimsNumber":0}"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 200 OK | DefClaimsDetail |
401 | Unauthorized | Unauthorized | ErrorDetail |
403 | Forbidden | Forbidden | ErrorDetail |
404 | Not Found | Recurso no encontrado | ErrorDetail |
500 | Internal Server Error | Internal error | ErrorDetail |
get__incidents_{organisationID}defendant_claims{incidentID}
Code samples
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.get 'https://$(catalog.host)/modules/incidents/{organisationID}/defendant/claims/{incidentID}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.get('https://$(catalog.host)/modules/incidents/{organisationID}/defendant/claims/{incidentID}', headers = headers)
print(r.json())
GET https://$(catalog.host)/modules/incidents/{organisationID}/defendant/claims/{incidentID} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/modules/incidents/{organisationID}/defendant/claims/{incidentID}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /incidents/{organisationID}/defendant/claims/{incidentID}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
organisationID | path | string | true | identificador de la firma |
language | query | string | false | Idioma generación |
incidentID | path | string | true | none |
Example responses
200 Response
"{"claimConcept":{"code":"string","description":"string"},"claimPublicationDate":"string","claimantType":{"code":"string","description":"string"},"claimedAmount":"string","companyName":"string","endDate":"string","mainAddress":{"country":{"code":"string","value":"string"},"dateUntil":"2019-10-07T10:34:35.001Z","fullAddress":"string","number":"string","otherDetails":"string","postcode":"string","province":{"code":"string","value":"string"},"streetName":"string","streetType":{"code":"string","value":"string"},"town":{"code":"string","value":"string"},"urbanArea":"string"},"publishedMedia":{"code":"string","description":"string"},"startDate":"string","taxId":"string"}"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 200 OK | DefClaimsIDDetail |
401 | Unauthorized | Unauthorized | ErrorDetail |
403 | Forbidden | Forbidden | ErrorDetail |
404 | Not Found | Recurso no encontrado | ErrorDetail |
500 | Internal Server Error | Internal error | ErrorDetail |
Schemas
ErrorDetail
"{"code":"string","message":"string","principal":"string","status":0}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | string | false | none | none |
message | string | false | none | none |
principal | string | false | none | none |
status | number | false | none | none |
DefClaimsDetail
"{"claims":[{"claimConcept":{"description":"string","id":"string"},"claimPublicationDate":"string","claimantType":{"description":"string","id":"string"},"claimedAmount":"string","endDate":"string","id":0,"idFile":"string","startDate":"string"}],"claimsNumber":0}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
claims | [object] | false | none | none |
claimConcept | object | false | none | none |
description | string | false | none | none |
id | string | false | none | none |
claimPublicationDate | string | false | none | none |
claimantType | object | false | none | none |
description | string | false | none | none |
id | string | false | none | none |
claimedAmount | string | false | none | none |
endDate | string | false | none | none |
id | number | false | none | none |
idFile | string | false | none | none |
startDate | string | false | none | none |
claimsNumber | number | false | none | none |
DefClaimsIDDetail
"{"claimConcept":{"code":"string","description":"string"},"claimPublicationDate":"string","claimantType":{"code":"string","description":"string"},"claimedAmount":"string","companyName":"string","endDate":"string","mainAddress":{"country":{"code":"string","value":"string"},"dateUntil":"2019-10-07T10:34:35.001Z","fullAddress":"string","number":"string","otherDetails":"string","postcode":"string","province":{"code":"string","value":"string"},"streetName":"string","streetType":{"code":"string","value":"string"},"town":{"code":"string","value":"string"},"urbanArea":"string"},"publishedMedia":{"code":"string","description":"string"},"startDate":"string","taxId":"string"}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
claimConcept | object | false | none | none |
code | string | false | none | none |
description | string | false | none | none |
claimPublicationDate | string | false | none | none |
claimantType | object | false | none | none |
code | string | false | none | none |
description | string | false | none | none |
claimedAmount | string | false | none | none |
companyName | string | false | none | none |
endDate | string | false | none | none |
mainAddress | object | false | none | none |
country | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
dateUntil | string | false | none | none |
fullAddress | string | false | none | none |
number | string | false | none | none |
otherDetails | string | false | none | none |
postcode | string | false | none | none |
province | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
streetName | string | false | none | none |
streetType | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
town | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
urbanArea | string | false | none | none |
publishedMedia | object | false | none | none |
code | string | false | none | none |
description | string | false | none | none |
startDate | string | false | none | none |
taxId | string | false | none | none |